﻿namespace WindowsFormsApplication1.Model
{
    /// <summary>
    /// 腾讯地图关键词输入提示API请求参数实体类
    /// </summary>
    public class TxMapGuideSuggestRequestDto
    {
        /// <summary>
        /// 搜索关键词
        /// </summary>
        public string KeyWord { get; set; }

        /// <summary>
        /// 限制城市范
        /// </summary>
        public string Region { get; set; }

        /// <summary>
        /// 区域限制
        /// 0：[默认]当前城市无结果时，自动扩大范围到全国匹配 
        /// 1：固定在当前城市
        /// </summary>
        public string RegionFix { get; set; }

        /// <summary>
        /// 定位坐标
        /// 传入后，若用户搜索关键词为类别词（如酒店、餐馆时），与此坐标距离近的地点将靠前显示，
        /// 格式： location=lat,lng
        /// </summary>
        public string Location { get; set; }

        /// <summary>
        /// 检索策略，目前支持：
        /// policy=0：默认，常规策略
        /// policy = 1：本策略主要用于收货地址、上门服务地址的填写， 
        /// 提高了小区类、商务楼宇、大学等分类的排序，过滤行政区、
        /// 道路等分类（如海淀大街、朝阳区等），排序策略引入真实用户对输入提示的点击热度，
        /// 使之更为符合此类应用场景，体验更为舒适
        /// policy = 10：出行场景（网约车） – 起点查询
        /// policy = 11：出行场景（网约车） – 终点查询
        /// </summary>
        public string Policy { get; set; }

        /// <summary>
        /// 本语法：columnName<筛选列>=value<列值>；
        /// 目前支持按POI分类筛选（例：category=分类词），若指定多个分类用英文逗号分隔，最多支持五个分类,
        /// </summary>
        public string Filter { get; set; }

        /// <summary>
        /// 可选值：short 
        /// 返回“不带行政区划的”短地址
        /// </summary>
        public string AddressFormat { get; set; }

        /// <summary>
        /// 页码，从1开始，最大页码需通过count进行计算，必须与page_size同时使用
        /// </summary>
        public string PageIndex { get; set; }

        /// <summary>
        /// 每页条数，取值范围1-20，必须与page_index 时使用
        /// </summary>
        public string PageSize { get; set; }

        /// <summary>
        /// 开发密钥（Key）
        /// </summary>
        public string Key { get; set; }

        /// <summary>
        /// 返回格式：支持JSON/JSONP，默认JSON
        /// </summary>
        public string Output { get; set; }
    }
}